Payment Methods Biz API

(0 reviews)

DELETE - paymentMethod (Digital to SF)

DELETE

This operation allows to delete a payment method from SF

Request

This section defines all the possible data structures sent by the client when consuming the method.

URL PARAMS

name	type	description	required
businessId	string	2 letter ISO 3166 country code ( PR ) identifying the business unit. Expected one is "PR"-Puerto Rico	Y
id	string	PaymentMethod id	Y

Security Headers

name	type	description	required
client_id	string	The client_id identifying the channel. Minimum characters: 5	Y
client_secret	string	Password associated with the client_id. Minimum characters: 5	Y

name	type	description	required
X-Correlation-ID	string	Identifier that correlates HTTP request between a client and server. Any identification model (UUDI, checksum, etc.) can be used, as long as it is a unique value to differentiate a transaction.	N

Body

Request Body for PR

{
    "account": [
        {
            "id": "BANXXXX-CANYYY",
            "@type": "BillingAccount",
            "relatedParty": [
                {
                    "id": "649824098",
                    "@type": "msisdn"
                }
            ]
        }
    ],
    "relatedParty": [
        {
            "name": "Digital",
            "@type": "channel"
        }
    ]
}

Definitions

Each of the request parameters is detailed.

name	type	description	required	possible values
account	array		Y
account.id	string	Value of Billing Account Number Conditional mandatory. either Billing Account Number or MSISDN should be passed	Y*	BANXXXX-CANYYY
account.@type	string	type of account.here it is Billing Account	N	BillingAccount
account.relatedParty	array		Y*
account.relatedParty.id	string	Value of MSISDN Conditional mandatory. either Billing Account Number or MSISDN should be passed	Y*	649824098
account.relatedParty.@type	string	type is MSISDN	N	msisdn
relatedParty	array		Y
relatedParty.name	string	Name of the relatedParty	Y	Digital/ivr
relatedParty.@type	string	The type of the relatedParty	Y	channel

Response

In this section all the possible data structures received by the client at the moment of responding the method are defined.

Possible response success

This section defines all the possible data structures received by the client and that must be considered satisfactory at the time of responding to the method.